#region Copyright(c) 2006 ZO, All right reserved.
// -----------------------------------------------------------------------------
// Copyright(c) 2006 ZO, All right reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
//   1.  Redistribution of source code must retain the above copyright notice,
//       this list of conditions and the following disclaimer.
//   2.  Redistribution in binary form must reproduce the above copyright
//       notice, this list of conditions and the following disclaimer in the
//       documentation and/or other materials provided with the distribution.
//   3.  The name of the author may not be used to endorse or promote products
//       derived from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
// EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
// -----------------------------------------------------------------------------
#endregion


#region Using directives

using System;
using ZO.SmartCore.Core;
using ZO.SmartCore.Plugins;
using ZO.SmartCore.Windows.Forms.OptionControls;
using Version= ZO.SmartCore.Core.Version;

#endregion

namespace ZO.SmartMessenger.Plugins
{
    /// <summary>
    /// Represent a protocol plugin to support new protolcol support
    /// </summary>
    public abstract class BasePlugin : RemotableDisposableObject, IPlugin
    {

        #region Constructors

        #endregion

        #region Destructor

        #endregion

        #region Fields

        #endregion

        #region Events

        #endregion

        #region Operators

        #endregion

        #region Properties

        #endregion

        #region Methods
 
        #endregion

        #region IPlugin Members

        /// <summary>
        /// Gets the type of the plugin.
        /// </summary>
        /// <value>The plugin type.</value>
        public abstract PluginType Type { get; }


		/// <summary>
		/// Gets the option window used to set the option for plugin.
		/// </summary>
		/// <value>The option window.</value>
		public virtual SmartOptionPage OptionWindow
		{
			get { return null; }

		}

        #endregion

        #region IPluginInfo Members

        /// <summary>
        /// Returns the name of this plugin.
        /// </summary>
        /// <value>Plugin Name</value>
        public abstract string Name { get; }

        /// <summary>
        /// Returns the ID of this plugin.
        /// </summary>
        /// <value>plugin Id must be unique</value>
        public abstract Guid ID { get; }

        /// <summary>
        /// Gets the image that will be displayed in the About dialog.
        /// </summary>
        /// <value>plugin logo if any</value>
        public virtual PluginImage Image
        {
            get { return null; }
        }

        /// <summary>
        /// this info is used if Application want to show info about updating assembly
        /// </summary>
        /// <value>URL Update Text</value>
        public virtual string UpdateText
        {
            get { return null; }
        }

        /// <summary>
        /// Gets the title of the plugin module displayed in the About dialog.
        /// </summary>
        /// <value>plugin title</value>
        public abstract string Title { get; }

        /// <summary>
        /// A short description of this plugin.
        /// </summary>
        /// <value>plugin description</value>
        public virtual string Description
        {
            get { return null; }
        }

        /// <summary>
        /// Get the starting date of this plugin's operating window if it expires
        /// </summary>
        /// <value>plugin start date</value>
        public virtual DateTime StartDate
        {
            get { return DateTime.MinValue; }
        }

        /// <summary>
        /// Get the expiration date of this plugin's operating window if it expires
        /// </summary>
        /// <value>plugin expire date if plugin can expires</value>
        public virtual DateTime ExpirationDate
        {
            get { return DateTime.MaxValue; }
        }

        /// <summary>
        /// Gets whether this plugin expires..
        /// </summary>
        /// <value><c>true</c> if expires; otherwise, <c>false</c>.</value>
        public virtual bool Expires
        {
            get { return false; }
        }

        /// <summary>
        /// Gets the plugin trademark.
        /// </summary>
        /// <value>The trademark.</value>
        public virtual string Trademark
        {
            get { return null; }
        }

        /// <summary>
        /// Gets the plugin copyright.
        /// </summary>
        /// <value>The copyright.</value>
        public virtual string Copyright
        {
            get { return null; }
        }

        /// <summary>
        /// URL to which request is forward for new version
        /// </summary>
        /// <value>URL to Update Assembly</value>
        public virtual Uri UpdateUrl
        {
            get { return null; }
        }

        /// <summary>
        /// Get the version of this product.
        /// </summary>
        /// <value>Plugin Version</value>
        public abstract Version Version { get; }


	
        #endregion
    }
}
